Adding proposal for test-mode retrospectively#1176
Conversation
📝 WalkthroughWalkthroughThis PR adds a proposal document describing Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/proposals/test-mode.md`:
- Line 46: The Markdown line "Recording source-build failures when fallback
succeeds ([`#1166`](`#limitations`))." contains a broken MyST anchor; edit that text
in docs/proposals/test-mode.md to remove the fragment by replacing the inline
link target "(`#limitations`)" with either a plain reference "[`#1166`]" or a full
GitHub issue URL "(https://github.com/.../issues/1166)" so the MyST parser can
resolve it (i.e., change "([`#1166`](`#limitations`))" to "([`#1166`])" or to the full
issue link).
- Around line 58-79: The Mermaid code fences in docs/proposals/test-mode.md are
causing Sphinx warnings because docs/conf.py only enables myst_parser
(myst_enable_extensions = ["colon_fence"]) and doesn’t treat ```mermaid as a
directive; fix by either converting/removing the mermaid diagrams in
test-mode.md to plain text/ASCII or static images, or add a Mermaid extension
and MyST config: install and enable a Sphinx Mermaid extension (e.g.,
sphinxcontrib-mermaid) and update docs/conf.py to treat mermaid fences as
directives (e.g., add myst_fence_as_directive = ["mermaid"] alongside
myst_enable_extensions) so the ```mermaid blocks are recognized and the
sphinx-build --fail-on-warning run no longer errors.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 662218e8-b2df-4358-9924-179ea2b24ea2
📒 Files selected for processing (1)
docs/proposals/test-mode.md
As the proposal docs are are useful to understand the architecture behind the big features we are doing. So having a doc which explain the motivation and architecture behind the feature would be useful for future contributors. Co-Authored-By: Claude <claude@anthropic.com> Signed-off-by: Lalatendu Mohanty <lmohanty@redhat.com>
55d5fb1 to
adfe0a3
Compare
As the proposal docs are are useful to understand the architecture behind the big features we are doing. So having a doc which explain the motivation and architecture behind the feature would be useful for future contributors.